home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 January: Mac OS SDK / Dev.CD Jan 99 SDK1.toast / Development Kits / Interfaces&Libraries / Universal / Interfaces / CIncludes / Translation.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-17  |  12.0 KB  |  328 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        Translation.h
  3.  
  4.      Contains:    Translation Manager (Macintosh Easy Open) Interfaces.
  5.  
  6.      Version:    Technology:    Macintosh Easy Open 1.1
  7.                  Release:    Universal Interfaces 3.2
  8.  
  9.      Copyright:    © 1991-1998 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __TRANSLATION__
  18. #define __TRANSLATION__
  19.  
  20. #ifndef __MACTYPES__
  21. #include <MacTypes.h>
  22. #endif
  23. #ifndef __FILES__
  24. #include <Files.h>
  25. #endif
  26. #ifndef __COMPONENTS__
  27. #include <Components.h>
  28. #endif
  29. #ifndef __TRANSLATIONEXTENSIONS__
  30. #include <TranslationExtensions.h>
  31. #endif
  32.  
  33.  
  34.  
  35. #if PRAGMA_ONCE
  36. #pragma once
  37. #endif
  38.  
  39. #ifdef __cplusplus
  40. extern "C" {
  41. #endif
  42.  
  43. #if PRAGMA_IMPORT
  44. #pragma import on
  45. #endif
  46.  
  47. #if PRAGMA_STRUCT_ALIGN
  48.     #pragma options align=mac68k
  49. #elif PRAGMA_STRUCT_PACKPUSH
  50.     #pragma pack(push, 2)
  51. #elif PRAGMA_STRUCT_PACK
  52.     #pragma pack(2)
  53. #endif
  54.  
  55. /* enumerated types on how a document can be opened*/
  56. typedef short                             DocOpenMethod;
  57.  
  58. enum {
  59.     domCannot                    = 0,
  60.     domNative                    = 1,
  61.     domTranslateFirst            = 2,
  62.     domWildcard                    = 3
  63. };
  64.  
  65. /* 0L terminated array of OSTypes, or FileTypes*/
  66. typedef OSType                             TypesBlock[64];
  67. typedef OSType *                        TypesBlockPtr;
  68. /* Progress dialog resource ID*/
  69.  
  70. enum {
  71.     kTranslationScrapProgressDialogID = -16555
  72. };
  73.  
  74. /* block of data that describes how to translate*/
  75.  
  76. struct FileTranslationSpec {
  77.     OSType                             componentSignature;
  78.     const void *                    translationSystemInfo;
  79.     FileTypeSpec                     src;
  80.     FileTypeSpec                     dst;
  81. };
  82. typedef struct FileTranslationSpec        FileTranslationSpec;
  83. typedef FileTranslationSpec *            FileTranslationSpecArrayPtr;
  84. typedef FileTranslationSpecArrayPtr *    FileTranslationSpecArrayHandle;
  85.  
  86. /*****************************************************************************************
  87. * 
  88. *   GetFileTypesThatAppCanNativelyOpen
  89. * 
  90. *  This routine returns a list of all FileTypes that an application can open by itself
  91. * 
  92. *  Enter:    appVRefNumHint        volume where application resides (can be wrong, and if is, will be used as a starting point)
  93. *             appSignature        signature (creator) of application
  94. *             nativeTypes            pointer to a buffer to be filled with up to 64 FileTypes
  95. * 
  96. *  Exit:    nativeTypes            zero terminated array of FileTypes that can be opened by app
  97. */
  98. EXTERN_API( OSErr )
  99. GetFileTypesThatAppCanNativelyOpen (short                 appVRefNumHint,
  100.                                  OSType                 appSignature,
  101.                                  FileType *                nativeTypes)                        TWOWORDINLINE(0x701C, 0xABFC);
  102.  
  103. /*****************************************************************************************
  104. * 
  105. *  ExtendFileTypeList
  106. * 
  107. *  This routine makes a new list of file types that can be translated into a type in the given list
  108. *  Used by StandardFile
  109. * 
  110. *  Enter:    originalTypeList        pointer to list of file types that can be opened
  111. *             numberOriginalTypes        number of file types in orgTypeList
  112. *              extendedTypeList        pointer to a buffer to be filled with file types
  113. *             numberExtendedTypes        max number of file types that can be put in extendedTypeList
  114. * 
  115. *  Exit:    extendedTypeList        buffer filled in with file types that can be translated
  116. *             numberExtendedTypes        number of file types put in extendedTypeList
  117. */
  118. EXTERN_API( OSErr )
  119. ExtendFileTypeList                (const FileType *        originalTypeList,
  120.                                  short                     numberOriginalTypes,
  121.                                  FileType *                extendedTypeList,
  122.                                  short *                numberExtendedTypes)                TWOWORDINLINE(0x7009, 0xABFC);
  123.  
  124.  
  125. /*****************************************************************************************
  126. * 
  127. * 
  128. *  This routine checks if a file can be opened by a particular application.
  129. *  If so, it returns if it needs to be translated first, and if so then how.
  130. *  The FileTypes that the app can open are specified by nativelyOpenableTypes,
  131. *  or if it is NULL, GetFileTypesThatAppCanNativelyOpen is called.
  132. * 
  133. *  Enter:    targetDocument        document to check if it can be opened
  134. *             appVRefNumHint        vRefNum of application to open doc ( can be wrong, and if is, will be used as a starting point)
  135. *             appSignature        signature (creator) of application to open doc
  136. *             nativeTypes            zero terminated list of FileTypes app can open natively, or NULL to use default list
  137. *             onlyNative            whether to consider if document can be translated before opening
  138. *             howToOpen            pointer to buffer in which to put how the document can be opened
  139. *             howToTranslate        pointer to buffer in which to put a FileTranslationSpec record
  140. * 
  141. *  Exit:    howToOpen            whether file needs to be translated to be read
  142. *             howToTranslate        if file can be translated, buffer filled in with how to translate
  143. *             returns                noErr, noPrefAppErr
  144. */
  145. EXTERN_API( OSErr )
  146. CanDocBeOpened                    (const FSSpec *            targetDocument,
  147.                                  short                     appVRefNumHint,
  148.                                  OSType                 appSignature,
  149.                                  const FileType *        nativeTypes,
  150.                                  Boolean                 onlyNative,
  151.                                  DocOpenMethod *        howToOpen,
  152.                                  FileTranslationSpec *    howToTranslate)                        TWOWORDINLINE(0x701E, 0xABFC);
  153.  
  154.  
  155. /*****************************************************************************************
  156. * 
  157. *  GetFileTranslationPaths
  158. * 
  159. *  This routine returns a list of all ways a translation can occure to or from a FileType.
  160. *  The app is checked to exist.  The hint for each app is the VRefNum and DTRefNum
  161. * 
  162. *  Enter:    srcDoc            source file or NULL for all matches
  163. *             dstDoc            destination FileType or 0 for all matches
  164. *             maxResultCount
  165. *             resultBuffer
  166. *  Exit:    number of paths
  167. */
  168. EXTERN_API( short )
  169. GetFileTranslationPaths            (FSSpec *                srcDocument,
  170.                                  FileType                 dstDocType,
  171.                                  unsigned short         maxResultCount,
  172.                                  FileTranslationSpecArrayPtr  resultBuffer)                    TWOWORDINLINE(0x7038, 0xABFC);
  173.  
  174. /*****************************************************************************************
  175. * 
  176. *  GetPathFromTranslationDialog
  177. * 
  178. *  This routine, with a given document, application, and a passed typelist will display the
  179. *  Macintosh Easy Open translation dialog allowing the user to make a choice.  The choice
  180. *  made will be written as a preference (so the next call to CanDocBeOpened() will work).
  181. *  The routine returns the translation path information.
  182. * 
  183. *  Enter:    theDocument            FSSpec to document to open
  184. *             theApplication        FSSpec to application to open document
  185. *             typeList            Nil terminated list of FileType's (e.g. SFTypeList-like) of types
  186. *                                 you would like the documented translated to.  Order most perferred
  187. *                                 to least.
  188. * 
  189. *  Exit:    howToOpen            Translation method needed to open document
  190. *             howToTranslate        Translation specification
  191. *             returns                Any errors that might occur.
  192. */
  193. EXTERN_API( OSErr )
  194. GetPathFromTranslationDialog    (const FSSpec *            theDocument,
  195.                                  const FSSpec *            theApplication,
  196.                                  TypesBlockPtr             typeList,
  197.                                  DocOpenMethod *        howToOpen,
  198.                                  FileTranslationSpec *    howToTranslate)                        TWOWORDINLINE(0x7037, 0xABFC);
  199.  
  200.  
  201. /*****************************************************************************************
  202. * 
  203. *   TranslateFile
  204. * 
  205. *  This routine reads a file of one format and writes it to another file in another format. 
  206. *  The information on how to translated is generated by the routine CanDocBeOpened.
  207. *  TranslateFile calls through to the TranslateFile Extension's DoTranslateFile routine.  
  208. *  The destination file must not exist.  It is created by this routine.  
  209. * 
  210. *  Enter:    sourceDocument            input file to translate
  211. *             destinationDocument        output file of translation
  212. *             howToTranslate            pointer to info on how to translate
  213. *  Exit:    returns                    noErr, badTranslationSpecErr 
  214. */
  215. EXTERN_API( OSErr )
  216. TranslateFile                    (const FSSpec *            sourceDocument,
  217.                                  const FSSpec *            destinationDocument,
  218.                                  const FileTranslationSpec * howToTranslate)                TWOWORDINLINE(0x700C, 0xABFC);
  219.  
  220. /*****************************************************************************************
  221. * 
  222. *   GetDocumentKindString
  223. * 
  224. *  This routine returns the string the Finder should show for the "kind" of a document
  225. *  in the GetInfo window and in the kind column of a list view.  
  226. * 
  227. *  Enter:    docVRefNum        The volume containing the document
  228. *             docType            The catInfo.fdType of the document
  229. *             docCreator        The catInfo.fdCreator of the document
  230. *             kindString        pointer to where to return the string
  231. * 
  232. *  Exit:    kindString        pascal string.  Ex: "\pSurfCalc spreadsheet"
  233. *             returns            noErr, or afpItemNoFound if kind could not be determined
  234. */
  235. EXTERN_API( OSErr )
  236. GetDocumentKindString            (short                     docVRefNum,
  237.                                  OSType                 docType,
  238.                                  OSType                 docCreator,
  239.                                  Str63                     kindString)                            TWOWORDINLINE(0x7016, 0xABFC);
  240.  
  241. /*****************************************************************************************
  242. * 
  243. *  GetTranslationExtensionName
  244. * 
  245. *  This routine returns the translation system name from a specified TranslationSpec
  246. * 
  247. *  Enter:    translationMethod    The translation path to get the translation name from
  248. * 
  249. *  Exit:    extensionName        The name of the translation system
  250. *             returns                Any errors that might occur
  251. */
  252. EXTERN_API( OSErr )
  253. GetTranslationExtensionName        (const FileTranslationSpec * translationMethod,
  254.                                  Str31                     extensionName)                        TWOWORDINLINE(0x7036, 0xABFC);
  255.  
  256.  
  257. /*****************************************************************************************
  258. * 
  259. *  GetScrapDataProcPtr
  260. * 
  261. *  This is a prototype for the function you must supply to TranslateScrap. It is called to 
  262. *  get the data to be translated.  The first call TranslateScrap will make to this is to
  263. *  ask for the 'fmts' data.  That is a special.   You should resize and fill in the handle
  264. *  with a list all the formats that you have available to be translated, and the length of each.
  265. *  (See I.M. VI 4-23 for details of 'fmts').  It will then be called again asking for one of  
  266. *  the formats that 'fmts' list said was available.
  267. * 
  268. *  Enter:    requestedFormat            Format of data that TranslateScrap needs.
  269. *             dataH                    Handle in which to put the requested data
  270. *             srcDataGetterRefCon        Extra parameter for you passed to TranslateScrap
  271. *             
  272. *  Exit:    dataH                    Handle is resized and filled with data in requested format
  273. */
  274. typedef CALLBACK_API( OSErr , GetScrapDataProcPtr )(ScrapType requestedFormat, Handle dataH, void *srcDataGetterRefCon);
  275. typedef STACK_UPP_TYPE(GetScrapDataProcPtr)                     GetScrapDataUPP;
  276. enum { uppGetScrapDataProcInfo = 0x00000FE0 };                     /* pascal 2_bytes Func(4_bytes, 4_bytes, 4_bytes) */
  277. #define NewGetScrapDataProc(userRoutine)                         (GetScrapDataUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppGetScrapDataProcInfo, GetCurrentArchitecture())
  278. #define CallGetScrapDataProc(userRoutine, requestedFormat, dataH, srcDataGetterRefCon)  CALL_THREE_PARAMETER_UPP((userRoutine), uppGetScrapDataProcInfo, (requestedFormat), (dataH), (srcDataGetterRefCon))
  279.  
  280. typedef GetScrapDataUPP                 GetScrapData;
  281. /*****************************************************************************************
  282. * 
  283. *  TranslateScrap
  284. * 
  285. *  This routine resizes the destination handle and fills it with data of the requested format.
  286. *  The data is generated by translated one or more source formats of data supplied by
  287. *  the procedure srcDataGetter.  
  288. *  This routine is automatically called by GetScrap and ReadEdition.  You only need to call
  289. *  this if you need to translated scrap style data, but are not using the ScrapMgr or EditionMgr.
  290. * 
  291. *  Enter:    sourceDataGetter            Pointer to routine that can get src data
  292. *             sourceDataGetterRefCon        Extra parameter for dataGetter
  293. *             destinationFormat            Format of data desired
  294. *             destinationData                Handle in which to store translated data
  295. *             
  296. *  Exit:    dstData                        Handle is resized and filled with data in requested format
  297. */
  298. EXTERN_API( OSErr )
  299. TranslateScrap                    (GetScrapDataUPP         sourceDataGetter,
  300.                                  void *                    sourceDataGetterRefCon,
  301.                                  ScrapType                 destinationFormat,
  302.                                  Handle                 destinationData,
  303.                                  short                     progressDialogID)                    TWOWORDINLINE(0x700E, 0xABFC);
  304.  
  305.  
  306.  
  307.  
  308. #if PRAGMA_STRUCT_ALIGN
  309.     #pragma options align=reset
  310. #elif PRAGMA_STRUCT_PACKPUSH
  311.     #pragma pack(pop)
  312. #elif PRAGMA_STRUCT_PACK
  313.     #pragma pack()
  314. #endif
  315.  
  316. #ifdef PRAGMA_IMPORT_OFF
  317. #pragma import off
  318. #elif PRAGMA_IMPORT
  319. #pragma import reset
  320. #endif
  321.  
  322. #ifdef __cplusplus
  323. }
  324. #endif
  325.  
  326. #endif /* __TRANSLATION__ */
  327.  
  328.